home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1999 July: Mac OS SDK / Dev.CD Jul 99 SDK1.toast / Development Kits / Mac OS / Interfaces&Libraries / Universal / Interfaces / AIncludes / WorldScript.a < prev    next >
Encoding:
Text File  |  1998-08-17  |  9.1 KB  |  274 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        WorldScript.a
  3. ;
  4. ;    Contains:    WorldScript I Interfaces.
  5. ;
  6. ;    Version:    Technology:    System 7.5
  7. ;                Release:    Universal Interfaces 3.2
  8. ;
  9. ;    Copyright:    © 1994-1998 by Apple Computer, Inc., all rights reserved.
  10. ;
  11. ;    Bugs?:        For bug reports, consult the following page on
  12. ;                the World Wide Web:
  13. ;
  14. ;                    http://developer.apple.com/bugreporter/
  15. ;
  16. ;
  17.     IF &TYPE('__WORLDSCRIPT__') = 'UNDEFINED' THEN
  18. __WORLDSCRIPT__ SET 1
  19.  
  20.     IF &TYPE('__MACTYPES__') = 'UNDEFINED' THEN
  21.     include 'MacTypes.a'
  22.     ENDIF
  23.     IF &TYPE('__TRAPS__') = 'UNDEFINED' THEN
  24.     include 'Traps.a'
  25.     ENDIF
  26.     IF &TYPE('__QUICKDRAWTEXT__') = 'UNDEFINED' THEN
  27.     include 'QuickdrawText.a'
  28.     ENDIF
  29.  
  30. ; typedef UInt16                         WSIOffset
  31.  
  32. ; typedef UInt8                         WSIByteCount
  33.  
  34. ; typedef UInt8                         WSIByteIndex
  35.  
  36. ;  offset from start of sub-table to row in state table 
  37. ; typedef UInt16                         WSIStateOffset
  38.  
  39. ; typedef UInt32                         WSITableOffset
  40.  
  41. ; typedef UInt16                         WSISubtableOffset
  42.  
  43. ; typedef UInt16                         WSIGlyphcode
  44.  
  45. ; typedef UInt32                         WSITableIdentifiers
  46.  
  47.  
  48. kScriptSettingsTag                EQU        'info'
  49. kMetamorphosisTag                EQU        'mort'
  50. kGlyphExpansionTag                EQU        'g2g#'
  51. kPropertiesTag                    EQU        'prop'
  52. kJustificationTag                EQU        'kash'
  53. kCharToGlyphTag                    EQU        'cmap'
  54. kGlyphToCharTag                    EQU        'pamc'
  55. kFindScriptRunTag                EQU        'fstb'
  56.  
  57.  
  58. ; ***             L O O K U P    T A B L E    T Y P E S        ***
  59.  
  60. WSILookupSimpleArray            EQU        0                    ; a simple array indexed by glyph code 
  61. WSILookupSegmentSingle            EQU        2                    ; segment mapping to single value 
  62. WSILookupSegmentArray            EQU        4                    ; segment mapping to lookup array 
  63. WSILookupSingleTable            EQU        6                    ; sorted list of glyph, value pairs 
  64. WSILookupTrimmedArray            EQU        8                    ; a simple trimmed array indexed by glyph code 
  65. ; typedef unsigned short                 WSILookupTableFormat
  66.  
  67. ; typedef unsigned short                 WSILookupValue
  68.  
  69. ;  An offset from the beginning of the lookup table 
  70. ; typedef unsigned short                 WSILookupOffset
  71.  
  72. ;     FORMAT SPECIFIC DEFINITIONS 
  73. ; 
  74. ;        lookupSimpleArray:
  75. ;        
  76. ;        This is a simple array which maps all glyphs in the font
  77. ;        to lookup values.
  78. ;    
  79.  
  80. WSILookupArrayHeader    RECORD 0
  81. lookupValues             ds.w    1                ; offset: $0 (0) <-- really an array of length one ;  The array of values indexed by glyph code 
  82. sizeof                     EQU *                    ; size:   $2 (2)
  83.                         ENDR
  84. ; 
  85. ;        lookupTrimmedArray:
  86. ;        
  87. ;        This is a single trimmed array which maps a single range
  88. ;        of glyhs in the font to lookup values.
  89. ;    
  90.  
  91. WSILookupTrimmedArrayHeader RECORD 0
  92. firstGlyph                 ds.w    1                ; offset: $0 (0)
  93. limitGlyph                 ds.w    1                ; offset: $2 (2)
  94. valueArray                 ds.w    1                ; offset: $4 (4) <-- really an array of length one
  95. sizeof                     EQU *                    ; size:   $6 (6)
  96.                         ENDR
  97. ;  The format specific part of the subtable header 
  98. WSILookupFormatSpecificHeader RECORD 0
  99. simpleArray                 ds        WSILookupArrayHeader ; offset: $0 (0)    ;  rename lookupArray as simpleArray <9> 
  100.                          ORG 0
  101. trimmedArray             ds        WSILookupTrimmedArrayHeader ; offset: $0 (0)
  102. sizeof                     EQU *                    ; size:   $6 (6)
  103.                         ENDR
  104. ;  The overall subtable header 
  105. WSILookupTableHeader    RECORD 0
  106. format                     ds.w    1                ; offset: $0 (0)        ;  table format 
  107. fsHeader                 ds        WSILookupFormatSpecificHeader ; offset: $2 (2) ;  format specific header 
  108. sizeof                     EQU *                    ; size:   $8 (8)
  109.                         ENDR
  110.  
  111. ; ***        G L Y P H    E X P A N S I O N    ***
  112.  
  113.                                                             ; fixed 1.0 
  114. kCurrentGlyphExpansionVersion    EQU        $00010000
  115. ; typedef unsigned short                 GlyphExpansionFormats
  116.  
  117.  
  118. GlyphExpansionLookupFormat        EQU        1
  119. GlyphExpansionContextualFormat    EQU        2
  120. ExpandedGlyphCluster    RECORD 0
  121. numGlyphs                 ds.b    1                ; offset: $0 (0)
  122. bestGlyph                 ds.b    1                ; offset: $1 (1)
  123. glyphs                     ds.w    1                ; offset: $2 (2) <-- really an array of length one
  124. sizeof                     EQU *                    ; size:   $4 (4)
  125.                         ENDR
  126. ExpandedGlyphOffset        RECORD 0
  127. glyph                     ds.w    1                ; offset: $0 (0)
  128. offset                     ds.w    1                ; offset: $2 (2)        ;  offset to ExpandedGlyphCluster 
  129. sizeof                     EQU *                    ; size:   $4 (4)
  130.                         ENDR
  131. GlyphExpansionStateTable RECORD 0
  132. stateTableOffset         ds.w    1                ; offset: $0 (0)
  133. classTableOffset         ds.w    1                ; offset: $2 (2)
  134. actionTableOffset         ds.w    1                ; offset: $4 (4)        ;  state, class and actions tables follow here... 
  135. sizeof                     EQU *                    ; size:   $6 (6)
  136.                         ENDR
  137. GlyphExpansionTable        RECORD 0
  138. version                     ds.l    1                ; offset: $0 (0)
  139. format                     ds.w    1                ; offset: $4 (4)
  140. expansionNumer             ds.w    1                ; offset: $6 (6)
  141. expansionDenom             ds.w    1                ; offset: $8 (8)        ;  num/denom ratio for expansion <2> 
  142. stateTable                 ds        GlyphExpansionStateTable ; offset: $A (10)
  143.                          ORG 10
  144. lookup                     ds        WSILookupTableHeader ; offset: $A (10) ;  expanded glyph clusters follow here... 
  145. sizeof                     EQU *                    ; size:   $12 (18)
  146.                         ENDR
  147.  
  148. ;  Glyph-to-Character constants and types  
  149.  
  150. kCurrentGlyphToCharVersion        EQU        $00010100
  151. ; typedef unsigned short                 GlyphToCharLookupFormats
  152.  
  153.  
  154. kGlyphToCharLookup8Format        EQU        1
  155. kGlyphToCharLookup16Format        EQU        2
  156. kGlyphToCharLookup32Format        EQU        3
  157. ; typedef UInt8                         GlyphToCharFontIndex
  158.  
  159. ; typedef UInt8                         QDGlyphcode
  160.  
  161. GlyphToCharActionTable    RECORD 0
  162. fontNameOffset             ds.w    1                ; offset: $0 (0)        ;  offset relative to this table 
  163. actions                     ds        WSILookupTableHeader ; offset: $2 (2)    ;  only support lookupSimpleArray format for now 
  164. sizeof                     EQU *                    ; size:   $A (10)
  165.                         ENDR
  166. GlyphToCharActionHeader    RECORD 0
  167. numTables                 ds.w    1                ; offset: $0 (0)        ;  0..n 
  168. offsets                     ds.w    1                ; offset: $2 (2) <-- really an array of length one ;  offsets from start of action table header 
  169. sizeof                     EQU *                    ; size:   $4 (4)
  170.                         ENDR
  171. GlyphToCharHeader        RECORD 0
  172. version                     ds.l    1                ; offset: $0 (0)
  173. actionOffset             ds.w    1                ; offset: $4 (4)        ;  offset to GlyphToCharActionHeader 
  174. format                     ds.w    1                ; offset: $6 (6)        ;  size of font mask 
  175. mappingTable             ds        WSILookupTableHeader ; offset: $8 (8)
  176. sizeof                     EQU *                    ; size:   $10 (16)
  177.                         ENDR
  178.  
  179. ;  JUSTIFICATION TYPES
  180. ;    WorldScript supports justification of text using insertion. The justification
  181. ;    table specifies a insertion string to insert between 2 specified glyphs.
  182. ;    Each combination of inter-glyph boundary can be assigned a justification priority,
  183. ;    the higher the priority the more justification strings inserted at that position.
  184. ;    
  185. ;    The priorities for each inter-glyph boundary are specified by the justification table's
  186. ;    state table.
  187. ;    
  188. ;    Special handling is done for scripts which use spaces to justify, because the width of 
  189. ;    a space varies depending on the setting of SpaceExtra. This is why the number of spaces
  190. ;    per inserting string is specified in the justification table.
  191. ;
  192. ;
  193.  
  194.  
  195.                                                             ; 1.0 not supported 
  196. kCurrentJustificationVersion    EQU        $0200
  197.  
  198. kJustificationStateTableFormat    EQU        1
  199.  
  200.                                                             ; WSI's internal limitation <12> 
  201. kMaxJustificationStringLength    EQU        13
  202. ; typedef UInt8                         WSIJustificationPriority
  203.  
  204.  
  205. WSIJustificationSetMarkMask        EQU        $80
  206. WSIJustificationStateEntry RECORD 0
  207. markPriority             ds.b    1                ; offset: $0 (0)        ;  non-zero priorities means insertion 
  208. priority                 ds.b    1                ; offset: $1 (1)
  209. newState                 ds.w    1                ; offset: $2 (2)
  210. sizeof                     EQU *                    ; size:   $4 (4)
  211.                         ENDR
  212. ; typedef unsigned short                 WSIJustificationClasses
  213.  
  214.  
  215. wsiJustEndOfLineClass            EQU        0
  216. wsiJustEndOfRunClass            EQU        1
  217. wsiJustDeletedGlyphClass        EQU        2
  218. wsiJustUserDefinedClass            EQU        3
  219. ; typedef unsigned short                 WSIJustificationStates
  220.  
  221.  
  222. wsiStartOfLineState                EQU        0                    ; pre-defined states 
  223. wsiStartOfRunState                EQU        1
  224. wsiUserDefinedState                EQU        2
  225. ;  pre-multiplied: class# * sizeof(WSIJustificationStateEntry) 
  226. ; typedef UInt8                         WSIJustificationClassOffset
  227.  
  228. WSIJustificationStateTable RECORD 0
  229. maxPriorities             ds.w    1                ; offset: $0 (0)
  230. rowWidth                 ds.w    1                ; offset: $2 (2)        ;  width of a state table row in bytes 
  231. classTableOffset         ds.w    1                ; offset: $4 (4)
  232. stateTableOffset         ds.w    1                ; offset: $6 (6)
  233. sizeof                     EQU *                    ; size:   $8 (8)
  234.                         ENDR
  235. ; 
  236. ;            Last two fields of above structure - someday?
  237. ;            WSIJustificationClassOffset    classes[up to 64 classes supported];
  238. ;            WSIJustificationStateEntry    states[up to your heart's desire];
  239. ;        
  240.  
  241. WSIJustificationHeader    RECORD 0
  242. version                     ds.w    1                ; offset: $0 (0)
  243. format                     ds.w    1                ; offset: $2 (2)
  244. scaling                     ds        Point            ; offset: $4 (4)        ;  numer/denom scaling of priority weights <7> 
  245. spacesPerInsertion         ds.w    1                ; offset: $8 (8)        ;  # of $20 chars in justification insertion string <12> 
  246. justStringOffset         ds.w    1                ; offset: $A (10)        ;  offset to justification string 
  247. stateTable                 ds        WSIJustificationStateTable ; offset: $C (12) ;  long-aligned boundary aligned w/ spacesPerInsertion field - justification string follows 
  248. sizeof                     EQU *                    ; size:   $14 (20)
  249.                         ENDR
  250.  
  251. ;  Line Layout's Property table version <11> 
  252.  
  253.                                                             ; v1.0 
  254. currentPropsTableVersion        EQU        $00010000
  255.  
  256.                                                             ; version is octal 0100 or hex 0x40 (#64) 
  257. kCharToGlyphCurrentVersion        EQU        $40
  258. ;  pass as priorityWeight to JustifyWSILayout to use script's current just setting 
  259.  
  260. kScriptsDefaultJustWeight        EQU        -1
  261.  
  262. ;  feature selectors used in FindScriptRun and itl5 configuration tables <9> 
  263. ; typedef UInt16                         WSIFeatureType
  264.  
  265. ; typedef UInt16                         WSIFeatureSelector
  266.  
  267. WSIFeature                RECORD 0
  268. featureType                 ds.w    1                ; offset: $0 (0)
  269. featureSelector             ds.w    1                ; offset: $2 (2)
  270. sizeof                     EQU *                    ; size:   $4 (4)
  271.                         ENDR
  272.     ENDIF ; __WORLDSCRIPT__ 
  273.  
  274.